Download OpenAPI specification:Download
The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. To learn more, review the Administration API overview. This OpenAPI specification covers all of the collections with the exception of Alerts, Alert Configurations, and Events. Refer to the legacy documentation for the specifications of these resources.
Returns access logs for authentication attempts made to MongoDB Cloud database deployments.
Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.
Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.
Returns, adds, edits, and removes Atlas Search indexes. Also returns and updates user-defined analyzers.
Returns, adds, and removes Cloud Backup snapshot export buckets. Also returns and adds Cloud Backup export jobs.
Returns and edits custom DNS configurations for Atlas database deployments on AWS.
Returns, adds, and removes all private endpoints for Federated Database Instances and Online Archives in the specified project.
Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.
Returns and edits the Encryption at Rest using Customer Key Management configuration.
Returns events. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.
Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.
Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings.
Returns some text dummy data for test purposes.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"data":
"string",
-
"links":
[
-
]
}
Returns and adds restore jobs for database deployments that use Legacy Backups.
Returns Legacy Backup Checkpoint metadata. Checkpoints serve as additional restore points for sharded clusters at points in time between regular snapshots.
Returns, adds, edits, and removes network peering containers and peering connections.
Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds.
Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.
Returns, adds, edits, and removes network access limits to database deployments in MongoDB Cloud.
Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.
Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.
Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.
Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.